Skip to content

replace outdated 'MDwiki' references (fixes #3671) #3676

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

replace outdated 'MDwiki' references (fixes #3671) #3676

wants to merge 1 commit into from

Conversation

@Saby-Bishops
Copy link
Member

@Saby-Bishops Saby-Bishops commented Aug 29, 2025 •
edited
Loading

Important: Do not tick a checkbox if you haven’t performed its action.

Before Creating the Pull Request

  • Verify the changes are on a new branch other than master – it should say "compare: branch-name".
  • Start the pull request title with lowercase letters, e.g., add githubusername.md.
  • Add issue number to the end of the pull request title when applicable, e.g., update mi-faq.md (fixes #3264).

After Creating the Pull Request

  • Go to "Commits" tab, make sure the commit username is clickable and linked to your GitHub account correctly.
  • Review the "Files changed" tab to ensure there are no unnecessary files or changes included in the pull request.
  • Verify that the raw.githack preview link is included in the description.
    • Preview the MDwiki rendered changes using the raw.githack link. Ensure it displays as expected without any errors.
  • Drop a link to this pull request in our discord channel.

Description, Screenshots and/or Screencast

image image image

fixes #3671

Changes:

  • Replaced outdated references to "MDwiki" with more accurate terms like "this handbook" and "this guide" in vi-first-steps.md.
  • This modernizes the documentation and reduces confusion for new interns, as the project now uses GitHub Pages with Jekyll instead of the MDwiki framework.

Raw.Githack Preview Link

https://raw.githack.com/Saby-Bishops/Saby-Bishops-Planet.github.io/3671-remove-mdwiki-refs/#!pages/vi/vi-first-steps.md

@jessewashburn
Copy link
Member

jessewashburn commented Aug 29, 2025 •
edited
Loading

Nice clean PR, but I think calling it an MDWiki is appropriate, since it clues interns into the fact they'll be working with markdown files. I'll defer to @Mutugiii in this case.

@Saby-Bishops
Copy link
Member Author

Nice clean PR, but I think calling it an MDWiki is appropriate, since it clues interns into the fact they'll be working with markdown files. I'll defer to @Mutugiii in this case.

Hey @Mutugiii @dogi @jessewashburn, could you please provide some guidance on this PR?

The change is simple, but the reasoning behind it (updating outdated terminology) is a broader question. Should we merge this to modernize the docs, or should we keep the historical "MDwiki" name for context?

If this isn't the right approach, please let me know if I should:

Close this PR and create a new issue altogether and work on that, or
Leave this PR open for it to be merged as-is.

@Mutugiii
Copy link
Member

We should keep the MDwiki name, since it helps interns to understand the underlying tech used in this repo: https://dynalon.github.io/mdwiki/#!index.md

I recommend closing this PR & related issue and instead work on a new one

dogi
dogi requested changes Sep 3, 2025
View reviewed changes
Copy link
Member

@dogi dogi left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

totally disagree with hiding
I am not sure if on all 3 places
but at least at one I would even double down and point by link to the original sources:
https://dynalon.github.io/mdwiki/#!index.md

@dogi dogi closed this Oct 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dogi dogi dogi requested changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Remove outdated reference to 'MDwiki' in vi-first-steps.md

4 participants

@Saby-Bishops @jessewashburn @Mutugiii @dogi